Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve howto_release.md #5170

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

neteler
Copy link
Member

@neteler neteler commented Feb 21, 2025

This PR aims to improve the (complex) release procedure:

  • re-order creation and use of variables
  • more use of the VERSION variable to avoid manual copy-pasting
  • propagate the correct VERSION number throughout the procedure by introducing a related new REL_VERSION variable

TODO:

  • understand how to properly use gh run list... (see below)
  • add what to do with the Zenodo batch

This PR aims to improve the (complex) release procedure:

- re-order creation and use of variables
- more use of VERSION variable to avoid manual copy-pasting
- propagate the correct VERSION number throughout the procedure
@neteler neteler added docs backport to 8.4 PR needs to be backported to release branch 8.4 labels Feb 21, 2025
@neteler neteler added this to the 8.5.0 milestone Feb 21, 2025
@neteler neteler self-assigned this Feb 21, 2025
@neteler neteler marked this pull request as ready for review February 24, 2025 15:37
@neteler neteler requested a review from wenzeslaus February 24, 2025 15:37
@neteler
Copy link
Member Author

neteler commented Feb 24, 2025

Note: I have tested the updated procedure with the new GRASS GIS 8.4.1 release.

@neteler
Copy link
Member Author

neteler commented Feb 24, 2025

Another question: in line 435 we have

"For final releases only, go to Zenodo and get a Markdown badge for the release which Zenodo creates with a DOI for the published release."

... and then what? For now I have added the badge to the release notes.

@echoix
Copy link
Member

echoix commented Feb 24, 2025

The latest docker tag is 12 months old:

https://hub.docker.com/layers/osgeo/grass-gis/latest/images/sha256-52d96c00a0109cd57c6f22495689fe51837c063cd1022dcd4a3da8e118bd2df8

The current* tags are 5 and 9 months old:
image
image

The 8.4.1 are correctly published:
image
image

@neteler
Copy link
Member Author

neteler commented Feb 24, 2025

The latest docker tag is 12 months old:
...
The current* tags are 5 and 9 months old:

The overall tag list looks okay: https://hub.docker.com/r/osgeo/grass-gis/tags

Seems the "latest" magic fails? Perhaps something for a separate issue (as docker is not part of this document)?

@echoix
Copy link
Member

echoix commented Feb 24, 2025

Seems the "latest" magic fails? Perhaps something for a separate issue (as docker is not part of this document)?

That's why I fixed it in #5128, as it was hardcoded to only do something with 8.3/releasebranch_8_3. After suggestion to backport it for helping this release, it was considered not needed and chosen to not backport it. So it needs to be tagged manually as the workflow that would do it is not on that branch.

@nilason
Copy link
Contributor

nilason commented Feb 24, 2025

it was considered not needed

I believe we didn't talk about the same thing :-(

@echoix
Copy link
Member

echoix commented Feb 24, 2025

it was considered not needed

I believe we didn't talk about the same thing :-(

I tried to be clear in https://discourse.osgeo.org/t/re-release-planning-grass-gis-8-4-1/112698/15
, using "docker workflow (GitHub actions, not Dockerfiles)", and followed up with

https://discourse.osgeo.org/t/re-release-planning-grass-gis-8-4-1/112698/22

@wenzeslaus
Copy link
Member

Another question: in line 435 we have

"For final releases only, go to Zenodo and get a Markdown badge for the release which Zenodo creates with a DOI for the published release."

... and then what? For now I have added the badge to the release notes.

I would do the same!

@@ -261,7 +271,7 @@ Eventually, commit with the suggested commit message and push, e.g.:
```bash
git show
eval $(./utils/update_version.py status --bash)
git commit include/VERSION -m "version: Back to $VERSION"
git commit include/VERSION -m "version: Start $VERSION"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Back to" versus "Start" is there for going from RC to the branch. Here is "version: Back to 8.4.1dev": 5890f9c

The correct commit message is generated by the script. That's why the version before current version had "..." and no eval (see b787bcc).

Copy link
Member Author

@neteler neteler Feb 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's solve it with a different variable.
Having "..." must be avoided - we want automation here and not manual copy-pasting by a (often tired) release manager :-) Manual copy-pasting is error-prone since the release procedure takes several hours in which the release manager does other tasks in parallel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport to 8.4 PR needs to be backported to release branch 8.4 docs markdown
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants